KFbxObject Class Reference

#include <kfbxobject.h>

Inheritance diagram for KFbxObject:

[legend]

List of all members.

---

Detailed Description

Basic class for object type identification and instance naming.

Definition at line 144 of file kfbxobject.h.

UpdateId Management
enum	eFbxUpdateIdType {    eUpdateId_Object,    eUpdateId_Dependency }
	Update ID type. More...
virtual kFbxUpdateId	GetUpdateId (eFbxUpdateIdType pUpdateId=eUpdateId_Object) const
	Returns the update ID of this object.
Properties access
KFbxProperty	RootProperty
KFbxProperty	GetFirstProperty () const
	Returns the first property of this object.
KFbxProperty	GetNextProperty (KFbxProperty const &pProperty) const
	Returns the next property of this object that follows the specified property.
KFbxProperty	FindProperty (const char *pName, bool pCaseSensitive=true) const
	Searches a property by name.
KFbxProperty	FindProperty (const char *pName, KFbxDataType const &pDataType, bool pCaseSensitive=true) const
	Searches a property by name and data type.
KFbxProperty	FindPropertyHierarchical (const char *pName, bool pCaseSensitive=true) const
	Searches a property by full name.
KFbxProperty	FindPropertyHierarchical (const char *pName, KFbxDataType const &pDataType, bool pCaseSensitive=true) const
	Searches a property by full name and data type.
KFbxProperty &	GetRootProperty ()
	Returns the root property of this object.
const KFbxProperty &	GetRootProperty () const
	Returns the root property of this object.
KFbxProperty	GetClassRootProperty ()
	Returns the class root property.
Cloning and references
virtual KFbxObject *	Clone (KFbxObject *pContainer, KFbxObject::ECloneType pCloneType) const
	Creates a clone of this object.
bool	IsAReferenceTo (void) const
	Checks if this object is a reference clone of another object.
KFbxObject *	GetReferenceTo (void) const
	If this object is a reference clone, returns the original object (from which the clone originates).
bool	IsReferencedBy (void) const
	Checks if any objects are reference cloned from this object.
int	GetReferencedByCount (void) const
	Returns the number of objects that are reference clones of this object.
KFbxObject *	GetReferencedBy (int pIndex) const
	Returns a reference clone of this object at the specified index.
Object Name Management
void	SetName (char const *pName)
	Sets the name of this object.
char const *	GetName () const
	Returns the full name of this object.
KString	GetNameWithoutNameSpacePrefix () const
	Returns the name of the object without the namespace qualifier.
KString	GetNameWithNameSpacePrefix () const
	Returns the name of the object with the namespace qualifier.
void	SetInitialName (char const *pName)
	Sets the initial name of the object.
char const *	GetInitialName () const
	Returns the initial name of the object.
KString	GetNameSpaceOnly ()
	Returns the namespace of the object.
void	SetNameSpace (KString pNameSpace)
	Sets the namespace of the object.
KArrayTemplate< KString * >	GetNameSpaceArray (char identifier)
	Returns an array of all the namespaces for this object.
KString	GetNameOnly () const
	Returns only the name (no namespace or prefix) of the object.
KString	GetNameSpacePrefix () const
	Returns the namespace qualifier.
KFbxObjectID const &	GetUniqueID () const
	Returns the unique ID of this object.
static KString	RemovePrefix (char *pName)
	Removes the prefix of pName.
static KString	StripPrefix (KString &lName)
	Strips the prefix of pName.
static KString	StripPrefix (const char *pName)
	Strips the prefix of pName.
Off-loading Management
Remarks: You can modify the unloaded state flag using the SetObjectFlags() method. The ContentIsUnloaded() method below (implemented in this class) is simply a synonym of GetObjectFlags(eCONTENT_UNLOADED_FLAG)
int	ContentUnload ()
	Unloads this object's content using the offload peripheral that is currently set in the document then flushes it from memory.
int	ContentLoad ()
	Loads this object's content using the offload peripheral that is currently set in the document.
bool	ContentIsLoaded () const
	Judges if this object's content is loaded.
void	ContentDecrementLockCount ()
	Decreases the content lock count of an object.
void	ContentIncrementLockCount ()
	Increases the content lock count of an object.
bool	ContentIsLocked () const
	Judges if this object's content is locked.
virtual void	ContentClear ()
	Clears this object's content from memory.
virtual KFbxPeripheral *	GetPeripheral ()
	Retrieves the peripheral of that object.
Off-loading Serialization section.
The methods in this section are usually called by a peripheral.
virtual bool	ContentWriteTo (KFbxStream &pStream) const
	Writes the content of the object to the given stream.
virtual bool	ContentReadFrom (const KFbxStream &pStream)
	Reads the content of the object from the given stream.
Selection management
virtual bool	GetSelected ()
	Returns if this object is currently in a selected state.
virtual void	SetSelected (bool pSelected)
	Sets whether this object is currently selected.
General Object Connection and Relationship Management
bool	ConnectSrcObject (KFbxObject *pObject, kFbxConnectionType pType=eFbxConnectionNone)
	Connects this object to a source object.
bool	IsConnectedSrcObject (const KFbxObject *pObject) const
	Judges whether this object connects with the source object.
bool	DisconnectSrcObject (KFbxObject *pObject)
	Disconnects this object from a source object.
bool	DisconnectAllSrcObject ()
	Disconnects this object from all source objects.
bool	DisconnectAllSrcObject (KFbxCriteria const &pCriteria)
	Disconnects this object from all source objects that satisfy a given criteria.
bool	DisconnectAllSrcObject (kFbxClassId pClassId)
	Disconnects this object from all source objects of a specific class type.
bool	DisconnectAllSrcObject (kFbxClassId pClassId, KFbxCriteria const &pCriteria)
	Disconnects this object from all source objects that satisfy a given criteria and that are a specific class type.
int	GetSrcObjectCount () const
	Returns the number of source objects with which this object connects.
int	GetSrcObjectCount (KFbxCriteria const &pCriteria) const
	Returns the number of source objects that satisfy the given criteria with which this object connects.
int	GetSrcObjectCount (kFbxClassId pClassId) const
	Returns the number of source objects of the specific class type with which this object connects.
int	GetSrcObjectCount (kFbxClassId pClassId, KFbxCriteria const &pCriteria) const
	Returns the number of source objects that satisfy the given criteria and that are the specified class type.
KFbxObject *	GetSrcObject (int pIndex=0) const
	Returns the source object with which this object connects at the specified index.
KFbxObject *	GetSrcObject (KFbxCriteria const &pCriteria, int pIndex=0) const
	Returns the source object that satisfies the criteria at the specified index with which this object connects.
KFbxObject *	GetSrcObject (kFbxClassId pClassId, int pIndex=0) const
	Returns the source object of the specified class type at the specified index with which this object connects.
KFbxObject *	GetSrcObject (kFbxClassId pClassId, KFbxCriteria const &pCriteria, int pIndex=0) const
	Returns the source object of the specified class type that satisfies the given criteria at the specified index.
KFbxObject *	FindSrcObject (const char *pName, int pStartIndex=0) const
	Searches the source object with the specified name, starting at the specified index.
KFbxObject *	FindSrcObject (KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
	Searches the source object with the specified name which satisfies the given criteria, starting at the specified index.
KFbxObject *	FindSrcObject (kFbxClassId pClassId, const char *pName, int pStartIndex=0) const
	Searches the source object with the specified name which is also the specified class type, starting at the specified index.
KFbxObject *	FindSrcObject (kFbxClassId pClassId, KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
	Searches the source object with the specified name which is the specified class type and satisfies the given criteria, starting at the specified index.
template<class T>
bool	DisconnectAllSrcObject (T const *pFBX_TYPE)
	Disconnects this object from all source objects of the specified class type.
template<class T>
bool	DisconnectAllSrcObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria)
	Disconnects this object from all source objects that are of the specified class type and that satisfy the given criteria.
template<class T>
int	GetSrcObjectCount (T const *pFBX_TYPE) const
	Returns the number of source objects of a specific class type with which this object connects.
template<class T>
int	GetSrcObjectCount (T const *pFBX_TYPE, KFbxCriteria const &pCriteria) const
	Returns the number of source objects with which this object connects that are the specified class type and that satisfy the given criteria.
template<class T>
T *	GetSrcObject (T const *pFBX_TYPE, int pIndex=0) const
	Returns the source object of the specified class type at the specified index.
template<class T>
T *	GetSrcObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, int pIndex=0) const
	Returns the source object that is the specified class type and that satisfies the given criteria at the specified index.
template<class T>
T *	FindSrcObject (T const *pFBX_TYPE, const char *pName, int pStartIndex=0) const
	Searches the source object with the specified name that is the specified class type, starting at the specified index.
template<class T>
T *	FindSrcObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
	Searches the source object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index.
bool	ConnectDstObject (KFbxObject *pObject, kFbxConnectionType pType=eFbxConnectionNone)
	Connects this object to one destination object.
bool	IsConnectedDstObject (const KFbxObject *pObject) const
	Judges whether this object connects with the destination object.
bool	DisconnectDstObject (KFbxObject *pObject)
	Disconnects this object from the destination object.
bool	DisconnectAllDstObject ()
	Disconnects this object from all destination objects.
bool	DisconnectAllDstObject (KFbxCriteria const &pCriteria)
	Disconnects this object from all destination objects that satisfy given criteria.
bool	DisconnectAllDstObject (kFbxClassId pClassId)
	Disconnects this object from all destination objects of the specified class type.
bool	DisconnectAllDstObject (kFbxClassId pClassId, KFbxCriteria const &pCriteria)
	Disconnects this object from all the destination objects that are the specified class type and that satisfy the given criteria.
int	GetDstObjectCount () const
	Returns the number of destination objects with which this object connects.
int	GetDstObjectCount (KFbxCriteria const &pCriteria) const
	Returns the number of destination objects with which this object connects that satisfy the given criteria.
int	GetDstObjectCount (kFbxClassId pClassId) const
	Returns the number of destination objects of the specified class type with which this object connects.
int	GetDstObjectCount (kFbxClassId pClassId, KFbxCriteria const &pCriteria) const
	Returns the number of destination objects of the specified class type with which this object connects that also satisfy the given criteria .
KFbxObject *	GetDstObject (int pIndex=0) const
	Returns the destination object at the specified index with which this object connects.
KFbxObject *	GetDstObject (KFbxCriteria const &pCriteria, int pIndex=0) const
	Returns the destination object with which this object connects that satisfies the given criteria at the specified index.
KFbxObject *	GetDstObject (kFbxClassId pClassId, int pIndex=0) const
	Returns the destination object of the specified class type with which this object connects at the specified index.
KFbxObject *	GetDstObject (kFbxClassId pClassId, KFbxCriteria const &pCriteria, int pIndex=0) const
	Returns the destination object with which this object connects that is of the specified class type and that satisfies the given criteria at the specified index.
KFbxObject *	FindDstObject (const char *pName, int pStartIndex=0) const
	Searches the destination object with the specified name, starting at the specified index.
KFbxObject *	FindDstObject (KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
	Searches the destination object with the specified name which satisfies the given criteria, starting at the specified index.
KFbxObject *	FindDstObject (kFbxClassId pClassId, const char *pName, int pStartIndex=0) const
	Searches the destination object with the specified name which is the specified class type, starting at the specified index.
KFbxObject *	FindDstObject (kFbxClassId pClassId, KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
	Searches the destination object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index.
template<class T>
bool	DisconnectAllDstObject (T const *pFBX_TYPE)
	Disconnects this object from all destination objects of the specified class type.
template<class T>
bool	DisconnectAllDstObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria)
	Disconnects this object from all destination objects that are the specified class type and that satisfy the given criteria.
template<class T>
int	GetDstObjectCount (T const *pFBX_TYPE) const
	Returns the number of destination objects of the specified class type with which this object connects.
template<class T>
int	GetDstObjectCount (T const *pFBX_TYPE, KFbxCriteria const &pCriteria) const
	Returns the number of destination objects with which this object connects that are the specified class type and that satisfy the given criteria.
template<class T>
T *	GetDstObject (T const *pFBX_TYPE, int pIndex=0) const
	Returns the destination object with which this object connects that is the specified class type at the specified index.
template<class T>
T *	GetDstObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, int pIndex=0) const
	Returns the destination object with which this object connects that is the specified class type and that satisfies the given criteria at the specified index.
template<class T>
T *	FindDstObject (T const *pFBX_TYPE, const char *pName, int pStartIndex=0) const
	Searches the destination object with the specified name which is of the specified class type, starting at the specified index.
template<class T>
T *	FindDstObject (T const *pFBX_TYPE, KFbxCriteria const &pCriteria, const char *pName, int pStartIndex=0) const
	Searches the destination object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index.
General Property Connection and Relationship Management
bool	ConnectSrcProperty (KFbxProperty const &pProperty)
	Connects this object to a source property.
bool	IsConnectedSrcProperty (KFbxProperty const &pProperty)
	Judges whether this object connects with the specified source property.
bool	DisconnectSrcProperty (KFbxProperty const &pProperty)
	Disconnects this object from the specified source property.
int	GetSrcPropertyCount () const
	Returns the number of source properties with which this object connects.
KFbxProperty	GetSrcProperty (int pIndex=0) const
	Returns the source property at the specified index with which this object connects.
KFbxProperty	FindSrcProperty (const char *pName, int pStartIndex=0) const
	Searches a source property with which this object connects that has a specific name, starting at the specified index.
bool	ConnectDstProperty (KFbxProperty const &pProperty)
	Connects this object to a destination property.
bool	IsConnectedDstProperty (KFbxProperty const &pProperty)
	Judges if this object connects with the specified destination property.
bool	DisconnectDstProperty (KFbxProperty const &pProperty)
	Disconnects this object from the specified destination property.
int	GetDstPropertyCount () const
	Returns the number of destination properties with which this object connects.
KFbxProperty	GetDstProperty (int pIndex=0) const
	Returns the destination property at the specified index with which this object connects.
KFbxProperty	FindDstProperty (const char *pName, int pStartIndex=0) const
	Searches a destination property with which this object connects that has a specific name, starting at the specified index.
User data
void	SetUserDataPtr (KFbxObjectID const &pUserID, void *pUserData)
	Sets the data pointer for an user data record whose ID is pUserID.
void *	GetUserDataPtr (KFbxObjectID const &pUserID) const
	Returns the data pointer of an user data record whose ID is pUserID.
void	SetUserDataPtr (void *pUserData)
	Sets the data pointer for the user data record whose ID is the object ID.
void *	GetUserDataPtr () const
	Returns the data pointer of the user data record whose ID is the object ID.
Document Management
KFbxDocument *	GetDocument () const
	Returns a const pointer to the document that contains this object.
KFbxDocument *	GetRootDocument () const
	Returns a const pointer to the root document that contains this object.
KFbxScene *	GetScene () const
	Returns a const pointer to the scene that contains this object.
Logging.
void	EmitMessage (KFbxMessage *pMessage) const
	Emits a message in all available message emitters in the document or SDK manager.
Localization helper.
virtual const char *	Localize (const char *pID, const char *pDefault=NULL) const
	Localization helper function, it calls the implementation of FBX SDK manager.
Application Implementation Management
KFbxLibrary *	GetParentLibrary (void) const
	Returns a handle on the parent library of this object.
bool	AddImplementation (KFbxImplementation *pImplementation)
	Adds an implementation.
bool	RemoveImplementation (KFbxImplementation *pImplementation)
	Removes an implementation.
bool	HasDefaultImplementation (void) const
	Judges if this shading node has a default implementation.
KFbxImplementation *	GetDefaultImplementation (void) const
	Returns the default implementation of this shading node.
bool	SetDefaultImplementation (KFbxImplementation *pImplementation)
	Sets the default implementation of this shading node.
int	GetImplementationCount (const KFbxImplementationFilter *pCriteria=NULL) const
	Returns the number of implementations that satisfy a given criteria.
KFbxImplementation *	GetImplementation (int pIndex, const KFbxImplementationFilter *pCriteria=NULL) const
	Returns the implementation at the specified index that satisfies the given criteria.
Object Storage && Retrieval
virtual KString	GetUrl () const
	Returns the URL of this object.
virtual bool	SetUrl (char *pUrl)
	Sets the URL of this object.
Public Types
enum	ECloneType {    eSURFACE_CLONE,    eREFERENCE_CLONE,    eDEEP_CLONE }
	Types of clones that can be created for KFbxObject. More...
Public Member Functions
	KFBXOBJECT_DECLARE (KFbxObject, KFbxPlug)
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.

---

Member Enumeration Documentation

enum ECloneType

Types of clones that can be created for KFbxObject.

Enumerator:

eSURFACE_CLONE	A surface copy of the object.
eREFERENCE_CLONE	Changes to original object propagate to clone. Changes to clone do not propagate to original.
eDEEP_CLONE	A deep copy of the object. Changes to either the original or clone do not propagate to each other.

Definition at line 149 of file kfbxobject.h.

enum eFbxUpdateIdType

Update ID type.

• eUpdateId_Object
• eUpdateId_Dependency

Enumerator:

eUpdateId_Object
eUpdateId_Dependency

Definition at line 295 of file kfbxobject.h.

---

Member Function Documentation

KFBXOBJECT_DECLARE	(	KFbxObject	,
		KFbxPlug
	)

virtual KFbxObject* Clone	(	KFbxObject *	pContainer,
		KFbxObject::ECloneType	pCloneType
	)			const [virtual]

Creates a clone of this object.

Parameters:

	pContainer	The object, typically a document or a scene, that contains the new clone(can be NULL).
	pCloneType	The type of clone to be created.

Returns:

The new clone, or NULL (if the specified clone type is not supported).

Reimplemented in KFbxControlSetPlug, KFbxGeometry, KFbxMesh, KFbxNodeAttribute, and KFbxProceduralGeometry.

bool IsAReferenceTo

(

void

)

const

Checks if this object is a reference clone of another object.

Returns:

True if this object is a clone of another object, false otherwise

KFbxObject* GetReferenceTo

(

void

)

const

If this object is a reference clone, returns the original object (from which the clone originates).

Returns:

The original object, or NULL (if this object is not a reference clone).

bool IsReferencedBy

(

void

)

const

Checks if any objects are reference cloned from this object.

Returns:

True if there are objects reference cloned from this object, false otherwise.

int GetReferencedByCount

(

void

)

const

Returns the number of objects that are reference clones of this object.

Returns:

The number of objects that are reference clones of this object.

KFbxObject* GetReferencedBy

(

int

pIndex

)

const

Returns a reference clone of this object at the specified index.

Parameters:

pIndex

The specified index, valid values are [0, GetReferencedByCount())

Returns:

The reference clone, or NULL (if pIndex is out of range).

void SetName

(

char const *

pName

)

Sets the name of this object.

Parameters:

pName

The object name as a NULL terminated string.

char const* GetName

(

)

const

Returns the full name of this object.

Returns:

The full name as a NULL terminated string.

Reimplemented in KFbxKFCurveFilter, KFbxKFCurveFilterKeyReducer, KFbxKFCurveFilterConstantKeyReducer, KFbxKFCurveFilterMatrixConverter, KFbxKFCurveFilterResample, KFbxKFCurveFilterUnroll, KFbxKFCurveFilterGimbleKiller, KFbxKFCurveFilterTSS, KFbxKFCurveFilterKeySync, and KFbxKFCurveFilterScale.

Referenced by KFbxNameFilter::Match().

KString GetNameWithoutNameSpacePrefix

(

)

const

Returns the name of the object without the namespace qualifier.

Returns:

The object name without the namespace qualifier.

KString GetNameWithNameSpacePrefix

(

)

const

Returns the name of the object with the namespace qualifier.

Returns:

The object name with the namespace qualifier.

void SetInitialName

(

char const *

pName

)

Sets the initial name of the object.

Parameters:

pName

The object's initial name as a NULL terminated string.

char const* GetInitialName

(

)

const

Returns the initial name of the object.

Returns:

The object's initial name as a NULL terminated string.

KString GetNameSpaceOnly

(

)

Returns the namespace of the object.

Returns:

The object's namespace as a NULL terminated string.

void SetNameSpace

(

KString

pNameSpace

)

Sets the namespace of the object.

Parameters:

pNameSpace

The object's namespace as a NULL terminated string.

KArrayTemplate<KString*> GetNameSpaceArray

(

char

identifier

)

Returns an array of all the namespaces for this object.

Parameters:

identifier

The identifier of the namespaces.

Returns:

The array of all namespaces.

KString GetNameOnly

(

)

const

Returns only the name (no namespace or prefix) of the object.

Returns:

The name only as a NULL terminated string.

KString GetNameSpacePrefix

(

)

const

Returns the namespace qualifier.

Returns:

The namespace qualifier.

static KString RemovePrefix

(

char *

pName

)

[static]

Removes the prefix of pName.

Parameters:

pName

Whose prefix is removed.

Returns:

A temporary string without prefix.

static KString StripPrefix

(

KString &

lName

)

[static]

Strips the prefix of pName.

Parameters:

lName

Whose prefix is stripped.

Returns:

lName stripped of its prefix.

static KString StripPrefix

(

const char *

pName

)

[static]

Strips the prefix of pName.

Parameters:

pName

Whose prefix is stripped.

Returns:

A temporary string stripped of its prefix.

KFbxObjectID const& GetUniqueID

(

)

const

Returns the unique ID of this object.

virtual kFbxUpdateId GetUpdateId

(

eFbxUpdateIdType

pUpdateId = eUpdateId_Object

)

const [virtual]

Returns the update ID of this object.

Parameters:

pUpdateId

The update ID type.

Returns:

The update ID.

Reimplemented in KFbxNode.

int ContentUnload

(

)

Unloads this object's content using the offload peripheral that is currently set in the document then flushes it from memory.

Returns:

2 if the object's content is already unloaded or 1 if this object's content has been successfully unloaded to the current peripheral.

Remarks:

If the content is locked more than once, or the peripheral cannot handle this object's unloading, or if an error occurs, this method returns 0 and does not flush the content.

int ContentLoad

(

)

Loads this object's content using the offload peripheral that is currently set in the document.

Returns:

1 if this object's content has been successfully loaded from the current peripheral, 2 if the content is already loaded, and 0 if an error occurs or the object's content is locked.

Remarks:

On a successful Load attempt, the object content is locked.

bool ContentIsLoaded

(

)

const

Judges if this object's content is loaded.

Returns:

True if this object's content is loaded, false otherwise.

Remarks:

An object that has not been filled yet must be considered unloaded.

void ContentDecrementLockCount

(

)

Decreases the content lock count of an object.

If the content lock count of an object is greater than 0, the content of the object is considered locked.

void ContentIncrementLockCount

(

)

Increases the content lock count of an object.

If the content lock count of an object is greater than 0, the content of the object is considered locked.

bool ContentIsLocked

(

)

const

Judges if this object's content is locked.

The content is considered locked if the content lock count is greater than 0

Returns:

True if this object's content is locked, false otherwise.

Remarks:

A locked state prevents the object content from being unloaded from memory but does not block the loading.

virtual void ContentClear

(

)

[protected, virtual]

Clears this object's content from memory.

This method must be overridden in the derived classes.

Remarks:

This method is called by ContentUnload() if the object content's unloading is successful .

virtual KFbxPeripheral* GetPeripheral

(

)

[protected, virtual]

Retrieves the peripheral of that object.

Returns:

The current peripheral for that object

Remarks:

A peripheral manipulates the content of an object. For instance, a peripheral can load the connections of an object on demand.

Reimplemented in KFbxDocument.

virtual bool ContentWriteTo

(

KFbxStream &

pStream

)

const [virtual]

Writes the content of the object to the given stream.

Parameters:

pStream

The destination stream.

Returns:

True if the content is successfully processed by the receiving stream, false otherwise.

Reimplemented in KFbxGeometryBase, and KFbxPatch.

virtual bool ContentReadFrom

(

const KFbxStream &

pStream

)

[virtual]

Reads the content of the object from the given stream.

Parameters:

pStream

The source stream.

Returns:

True if the object fills itself with the received data from the stream successfully, false otherwise.

Reimplemented in KFbxGeometryBase, and KFbxPatch.

virtual bool GetSelected

(

)

[virtual]

Returns if this object is currently in a selected state.

Returns:

True if this object is selected, false otherwise.

virtual void SetSelected

(

bool

pSelected

)

[virtual]

Sets whether this object is currently selected.

Parameters:

pSelected

The selection flag.

KFbxProperty GetFirstProperty

(

)

const [inline]

Returns the first property of this object.

Returns:

The first property of this object.

Definition at line 423 of file kfbxobject.h.

Referenced by KFbxIterator::GetFirst().

KFbxProperty GetNextProperty

(

KFbxProperty const &

pProperty

)

const [inline]

Returns the next property of this object that follows the specified property.

Parameters:

pProperty

The specified property.

Returns:

The next property of this object that follows pProperty.

Definition at line 432 of file kfbxobject.h.

Referenced by KFbxIterator::GetNext().

KFbxProperty FindProperty	(	const char *	pName,
		bool	pCaseSensitive = true
	)			const [inline]

Searches a property by name.

Parameters:

	pName	The property name.
	pCaseSensitive	Whether the name is case-sensitive.

Returns:

A valid KFbxProperty if found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 442 of file kfbxobject.h.

KFbxProperty FindProperty	(	const char *	pName,
		KFbxDataType const &	pDataType,
		bool	pCaseSensitive = true
	)			const [inline]

Searches a property by name and data type.

Parameters:

	pName	The property name.
	pDataType	The data type of the property.
	pCaseSensitive	Whether the name is case-sensitive.

Returns:

A valid KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 453 of file kfbxobject.h.

KFbxProperty FindPropertyHierarchical	(	const char *	pName,
		bool	pCaseSensitive = true
	)			const [inline]

Searches a property by full name.

Parameters:

	pName	The full name of the property as a NULL terminated string.
	pCaseSensitive	whether or not the name is case-sensitive.

Returns:

A valid KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 464 of file kfbxobject.h.

Referenced by GetBoundPropertyValue().

KFbxProperty FindPropertyHierarchical	(	const char *	pName,
		KFbxDataType const &	pDataType,
		bool	pCaseSensitive = true
	)			const [inline]

Searches a property by full name and data type.

Parameters:

	pName	The full name of the property as a NULL terminated string.
	pDataType	The data type of the property.
	pCaseSensitive	whether or not the name is case-sensitive.

Returns:

A valid KFbxProperty if the property is found, else an invalid KFbxProperty. See KFbxProperty::IsValid()

Definition at line 476 of file kfbxobject.h.

KFbxProperty& GetRootProperty

(

)

[inline]

Returns the root property of this object.

Returns:

The root property.

Definition at line 484 of file kfbxobject.h.

const KFbxProperty& GetRootProperty

(

)

const [inline]

Returns the root property of this object.

Returns:

The root property.

Definition at line 489 of file kfbxobject.h.

KFbxProperty GetClassRootProperty

(

)

Returns the class root property.

Returns:

The class root property if it exists, else an invalid KFbxProperty. See KFbxProperty::IsValid().

Remarks:

Class KFbxObject and its sub-classes all have a class root property. This class root property contains basic information about the class type, such as the class name.

bool ConnectSrcObject	(	KFbxObject *	pObject,
		kFbxConnectionType	pType = eFbxConnectionNone
	)			[inline]

Connects this object to a source object.

Parameters:

	pObject	The source object to which this object connects.
	pType	The connection type between this object and the source object.

Returns:

True on success, false otherwise.

Definition at line 523 of file kfbxobject.h.

Referenced by KFbxCollection::AddMember(), and KFbxConnectSrc().

bool IsConnectedSrcObject

(

const KFbxObject *

pObject

)

const [inline]

Judges whether this object connects with the source object.

Parameters:

pObject

The source object.

Returns:

True if this object connects with the source object, false otherwise.

Definition at line 529 of file kfbxobject.h.

bool DisconnectSrcObject

(

KFbxObject *

pObject

)

[inline]

Disconnects this object from a source object.

Parameters:

pObject

The source object from which this object will be disconnected.

Returns:

True on success, false otherwise.

Definition at line 535 of file kfbxobject.h.

Referenced by KFbxCollection::RemoveMember().

bool DisconnectAllSrcObject

(

)

[inline]

Disconnects this object from all source objects.

Returns:

True if it disconnects all source objects successfully, false otherwise.

Definition at line 540 of file kfbxobject.h.

Referenced by KFbxDisconnectAllSrc().

bool DisconnectAllSrcObject

(

KFbxCriteria const &

pCriteria

)

[inline]

Disconnects this object from all source objects that satisfy a given criteria.

Parameters:

pCriteria

The given criteria.

Returns:

True if it disconnects all the source objects successfully, false otherwise.

Definition at line 546 of file kfbxobject.h.

bool DisconnectAllSrcObject

(

kFbxClassId

pClassId

)

[inline]

Disconnects this object from all source objects of a specific class type.

Parameters:

pClassId

The specific class type.

Returns:

True if it disconnects all source objects successfully, false otherwise.

Definition at line 552 of file kfbxobject.h.

bool DisconnectAllSrcObject	(	kFbxClassId	pClassId,
		KFbxCriteria const &	pCriteria
	)			[inline]

Disconnects this object from all source objects that satisfy a given criteria and that are a specific class type.

Parameters:

	pClassId	The specific class type.
	pCriteria	The given criteria.

Returns:

True if it disconnects from all source objects successfully, false otherwise.

Definition at line 559 of file kfbxobject.h.

int GetSrcObjectCount

(

)

const [inline]

Returns the number of source objects with which this object connects.

Returns:

The number of source objects with which this object connects.

Definition at line 564 of file kfbxobject.h.

Referenced by KFbxCollection::GetMemberCount(), and KFbxGetSrcCount().

int GetSrcObjectCount

(

KFbxCriteria const &

pCriteria

)

const [inline]

Returns the number of source objects that satisfy the given criteria with which this object connects.

Parameters:

pCriteria

The given criteria.

Returns:

The number of source objects that satisfy the given criteria with which this object connects.

Definition at line 570 of file kfbxobject.h.

int GetSrcObjectCount

(

kFbxClassId

pClassId

)

const [inline]

Returns the number of source objects of the specific class type with which this object connects.

Parameters:

pClassId

The specific class type.

Returns:

The number of source objects of the specific class type with which this object connects.

Definition at line 576 of file kfbxobject.h.

int GetSrcObjectCount	(	kFbxClassId	pClassId,
		KFbxCriteria const &	pCriteria
	)			const [inline]

Returns the number of source objects that satisfy the given criteria and that are the specified class type.

Parameters:

	pClassId	The specified class type.
	pCriteria	The given criteria.

Returns:

The number of source objects.

Definition at line 583 of file kfbxobject.h.

KFbxObject* GetSrcObject

(

int

pIndex = 0

)

const [inline]

Returns the source object with which this object connects at the specified index.

Parameters:

pIndex

The specified index whose default value is 0.

Returns:

The source object at the specified index, NULL if not found.

Definition at line 589 of file kfbxobject.h.

Referenced by KFbxCollection::GetMember(), and KFbxGetSrc().

KFbxObject* GetSrcObject	(	KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)			const [inline]

Returns the source object that satisfies the criteria at the specified index with which this object connects.

Parameters:

	pCriteria	The given criteria.
	pIndex	The specified index whose default value is 0.

Returns:

The source object that satisfies the given criteria at the specified index, NULL if not found.

Definition at line 596 of file kfbxobject.h.

KFbxObject* GetSrcObject	(	kFbxClassId	pClassId,
		int	pIndex = 0
	)			const [inline]

Returns the source object of the specified class type at the specified index with which this object connects.

Parameters:

	pClassId	The specified class type.
	pIndex	The specified index whose default value is 0.

Returns:

The source object of the specified class type at the specified index, NULL if not found.

Definition at line 603 of file kfbxobject.h.

KFbxObject* GetSrcObject	(	kFbxClassId	pClassId,
		KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)			const [inline]

Returns the source object of the specified class type that satisfies the given criteria at the specified index.

Parameters:

	pClassId	The specified class.
	pCriteria	The given criteria.
	pIndex	The specified index whose default value is 0.

Returns:

The source object of the specified class type that satisfies the given criteria at the specified index, NULL if not found.

Definition at line 611 of file kfbxobject.h.

KFbxObject* FindSrcObject	(	const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the source object with the specified name, starting at the specified index.

Parameters:

	pName	The object name.
	pStartIndex	The start index.

Returns:

The source object with the name, NULL if not found.

Definition at line 618 of file kfbxobject.h.

Referenced by KFbxCollection::FindMember(), and KFbxFindSrc().

KFbxObject* FindSrcObject	(	KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the source object with the specified name which satisfies the given criteria, starting at the specified index.

Parameters:

	pCriteria	The given criteria.
	pName	The object name.
	pStartIndex	The start index.

Returns:

The source object with the name, NULL if not found.

Definition at line 626 of file kfbxobject.h.

KFbxObject* FindSrcObject	(	kFbxClassId	pClassId,
		const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the source object with the specified name which is also the specified class type, starting at the specified index.

Parameters:

	pClassId	The specified class type.
	pName	The object name.
	pStartIndex	The start index.

Returns:

The source object with the name, NULL if not found.

Definition at line 634 of file kfbxobject.h.

KFbxObject* FindSrcObject	(	kFbxClassId	pClassId,
		KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the source object with the specified name which is the specified class type and satisfies the given criteria, starting at the specified index.

Parameters:

	pClassId	The specified class type.
	pCriteria	The given criteria.
	pName	The object name.
	pStartIndex	The start index.

Returns:

The source object with the name, NULL if not found.

Definition at line 643 of file kfbxobject.h.

bool DisconnectAllSrcObject

(

T const *

pFBX_TYPE

)

[inline]

Disconnects this object from all source objects of the specified class type.

Parameters:

pFBX_TYPE

The specified class type.

Returns:

True if it disconnects all source objects successfully, false otherwise.

Definition at line 649 of file kfbxobject.h.

bool DisconnectAllSrcObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria
	)			[inline]

Disconnects this object from all source objects that are of the specified class type and that satisfy the given criteria.

Parameters:

	pFBX_TYPE	The specified class type.
	pCriteria	The given criteria.

Returns:

True if it disconnects all source objects successfully, false otherwise.

Definition at line 656 of file kfbxobject.h.

int GetSrcObjectCount

(

T const *

pFBX_TYPE

)

const [inline]

Returns the number of source objects of a specific class type with which this object connects.

Parameters:

pFBX_TYPE

The specified class type.

Returns:

The number of source objects of the specified class type with which this object connects.

Definition at line 662 of file kfbxobject.h.

int GetSrcObjectCount	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria
	)			const [inline]

Returns the number of source objects with which this object connects that are the specified class type and that satisfy the given criteria.

Parameters:

	pFBX_TYPE	The specified class type.
	pCriteria	The given criteria.

Returns:

The number of source objects that are the specified class type and that satisfy the given criteria.

Definition at line 669 of file kfbxobject.h.

T* GetSrcObject	(	T const *	pFBX_TYPE,
		int	pIndex = 0
	)			const [inline]

Returns the source object of the specified class type at the specified index.

Parameters:

	pFBX_TYPE	The specified class type.
	pIndex	The specified index whose default value is 0.

Returns:

The source object of a specified class type at the specified index, NULL if not found.

Definition at line 676 of file kfbxobject.h.

T* GetSrcObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)			const [inline]

Returns the source object that is the specified class type and that satisfies the given criteria at the specified index.

Parameters:

	pFBX_TYPE	The specified class type.
	pCriteria	The given criteria.
	pIndex	The specified index whose default value is 0.

Returns:

The source object that is of the specified class type and that satisfies the given criteria at the specified index, NULL if not found.

Definition at line 684 of file kfbxobject.h.

T* FindSrcObject	(	T const *	pFBX_TYPE,
		const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the source object with the specified name that is the specified class type, starting at the specified index.

Parameters:

	pFBX_TYPE	The specified class type.
	pName	The object name.
	pStartIndex	The start index.

Returns:

The source object with the name, NULL if not found.

Definition at line 692 of file kfbxobject.h.

T* FindSrcObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the source object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index.

Parameters:

	pFBX_TYPE	The specified class type.
	pCriteria	The given criteria.
	pName	The object name.
	pStartIndex	The start index.

Returns:

The source object with the name, NULL if not found.

Definition at line 701 of file kfbxobject.h.

bool ConnectDstObject	(	KFbxObject *	pObject,
		kFbxConnectionType	pType = eFbxConnectionNone
	)			[inline]

Connects this object to one destination object.

Parameters:

	pObject	The destination object with which this object connects.
	pType	The connection type between this object and the destination object.

Returns:

True on success, false otherwise.

Definition at line 709 of file kfbxobject.h.

Referenced by KFbxConnectDst().

bool IsConnectedDstObject

(

const KFbxObject *

pObject

)

const [inline]

Judges whether this object connects with the destination object.

Parameters:

pObject

The destination object.

Returns:

True if this object connects with the destination object, false otherwise.

Definition at line 715 of file kfbxobject.h.

bool DisconnectDstObject

(

KFbxObject *

pObject

)

[inline]

Disconnects this object from the destination object.

Parameters:

pObject

The destination object from which this object disconnects.

Returns:

True on success, false otherwise.

Definition at line 721 of file kfbxobject.h.

bool DisconnectAllDstObject

(

)

[inline]

Disconnects this object from all destination objects.

Returns:

True if it disconnects all destination objects successfully, false otherwise.

Definition at line 726 of file kfbxobject.h.

Referenced by KFbxDisconnectAllDst().

bool DisconnectAllDstObject

(

KFbxCriteria const &

pCriteria

)

[inline]

Disconnects this object from all destination objects that satisfy given criteria.

Parameters:

pCriteria

The given criteria.

Returns:

True if it disconnects all destination objects successfully, false otherwise.

Definition at line 732 of file kfbxobject.h.

bool DisconnectAllDstObject

(

kFbxClassId

pClassId

)

[inline]

Disconnects this object from all destination objects of the specified class type.

Parameters:

pClassId

The specified class type.

Returns:

True if it disconnects all destination objects of the specified class type successfully, false otherwise.

Definition at line 738 of file kfbxobject.h.

bool DisconnectAllDstObject	(	kFbxClassId	pClassId,
		KFbxCriteria const &	pCriteria
	)			[inline]

Disconnects this object from all the destination objects that are the specified class type and that satisfy the given criteria.

Parameters:

	pClassId	The specified class type.
	pCriteria	The given criteria.

Returns:

True if it disconnects all the destination objects successfully, false otherwise.

Definition at line 745 of file kfbxobject.h.

int GetDstObjectCount

(

)

const [inline]

Returns the number of destination objects with which this object connects.

Returns:

The number of destination objects with which this object connects.

Definition at line 750 of file kfbxobject.h.

Referenced by KFbxGetDstCount().

int GetDstObjectCount

(

KFbxCriteria const &

pCriteria

)

const [inline]

Returns the number of destination objects with which this object connects that satisfy the given criteria.

Parameters:

pCriteria

The given criteria.

Returns:

The number of destination objects with which this object connects that satisfy the given criteria.

Definition at line 756 of file kfbxobject.h.

int GetDstObjectCount

(

kFbxClassId

pClassId

)

const [inline]

Returns the number of destination objects of the specified class type with which this object connects.

Parameters:

pClassId

The specified class type.

Returns:

The number of destination objects of the specified class type with which this object connects.

Definition at line 762 of file kfbxobject.h.

int GetDstObjectCount	(	kFbxClassId	pClassId,
		KFbxCriteria const &	pCriteria
	)			const [inline]

Returns the number of destination objects of the specified class type with which this object connects that also satisfy the given criteria .

Parameters:

	pClassId	The specified class type.
	pCriteria	The given criteria.

Returns:

The number of destination objects that are the specified class type and that satisfy the given criteria.

Definition at line 769 of file kfbxobject.h.

KFbxObject* GetDstObject

(

int

pIndex = 0

)

const [inline]

Returns the destination object at the specified index with which this object connects.

Parameters:

pIndex

The specified index whose default value is 0.

Returns:

The destination object at the specified index, NULL if not found.

Definition at line 775 of file kfbxobject.h.

Referenced by KFbxGetDst().

KFbxObject* GetDstObject	(	KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)			const [inline]

Returns the destination object with which this object connects that satisfies the given criteria at the specified index.

Parameters:

	pCriteria	The given criteria.
	pIndex	The specified index whose default value is 0.

Returns:

The destination object that satisfies the given criteria at the specified index, NULL if not found.

Definition at line 782 of file kfbxobject.h.

KFbxObject* GetDstObject	(	kFbxClassId	pClassId,
		int	pIndex = 0
	)			const [inline]

Returns the destination object of the specified class type with which this object connects at the specified index.

Parameters:

	pClassId	The specified class type.
	pIndex	The specified index whose default value is 0.

Returns:

The destination object of the specified class type at the specified index, NULL if not found.

Definition at line 789 of file kfbxobject.h.

KFbxObject* GetDstObject	(	kFbxClassId	pClassId,
		KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)			const [inline]

Returns the destination object with which this object connects that is of the specified class type and that satisfies the given criteria at the specified index.

Parameters:

	pClassId	The specified class type.
	pCriteria	The given criteria.
	pIndex	The specified index whose default value is 0.

Returns:

The destination object that is of the specified class type and that satisfies the given criteria at the specified index, NULL if not found.

Definition at line 797 of file kfbxobject.h.

KFbxObject* FindDstObject	(	const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the destination object with the specified name, starting at the specified index.

Parameters:

	pName	The object name.
	pStartIndex	The start index.

Returns:

The destination object with the name, NULL if not found.

Definition at line 804 of file kfbxobject.h.

Referenced by KFbxFindDst().

KFbxObject* FindDstObject	(	KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the destination object with the specified name which satisfies the given criteria, starting at the specified index.

Parameters:

	pCriteria	The given criteria.
	pName	The object name.
	pStartIndex	The start index.

Returns:

The destination object with the name, NULL if not found.

Definition at line 812 of file kfbxobject.h.

KFbxObject* FindDstObject	(	kFbxClassId	pClassId,
		const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the destination object with the specified name which is the specified class type, starting at the specified index.

Parameters:

	pClassId	The specified class type.
	pName	The object name.
	pStartIndex	The start index.

Returns:

The destination object with the name, NULL if not found.

Definition at line 820 of file kfbxobject.h.

KFbxObject* FindDstObject	(	kFbxClassId	pClassId,
		KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the destination object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index.

Parameters:

	pClassId	The specified class type.
	pCriteria	The given criteria.
	pName	The object name.
	pStartIndex	The start index.

Returns:

The destination object with the name, NULL if not found.

Definition at line 829 of file kfbxobject.h.

bool DisconnectAllDstObject

(

T const *

pFBX_TYPE

)

[inline]

Disconnects this object from all destination objects of the specified class type.

Parameters:

pFBX_TYPE

The specified class type.

Returns:

True if it disconnects all destination objects of the specified class type successfully, false otherwise.

Definition at line 835 of file kfbxobject.h.

bool DisconnectAllDstObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria
	)			[inline]

Disconnects this object from all destination objects that are the specified class type and that satisfy the given criteria.

Parameters:

	pFBX_TYPE	The specified class type.
	pCriteria	The given criteria.

Returns:

True if it disconnects all destination objects successfully, false otherwise.

Definition at line 842 of file kfbxobject.h.

int GetDstObjectCount

(

T const *

pFBX_TYPE

)

const [inline]

Returns the number of destination objects of the specified class type with which this object connects.

Parameters:

pFBX_TYPE

The specified class type.

Returns:

The number of destination objects of the specified class type with which this object connects.

Definition at line 848 of file kfbxobject.h.

int GetDstObjectCount	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria
	)			const [inline]

Returns the number of destination objects with which this object connects that are the specified class type and that satisfy the given criteria.

Parameters:

	pFBX_TYPE	The specified class type.
	pCriteria	The given criteria.

Returns:

The number of destination objects that are the specified class type and that satisfy the given criteria.

Definition at line 855 of file kfbxobject.h.

T* GetDstObject	(	T const *	pFBX_TYPE,
		int	pIndex = 0
	)			const [inline]

Returns the destination object with which this object connects that is the specified class type at the specified index.

Parameters:

	pFBX_TYPE	The specified class type.
	pIndex	The specified index whose default value is 0.

Returns:

The destination object of the specified class type at the specified index, NULL if not found.

Definition at line 862 of file kfbxobject.h.

T* GetDstObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria,
		int	pIndex = 0
	)			const [inline]

Returns the destination object with which this object connects that is the specified class type and that satisfies the given criteria at the specified index.

Parameters:

	pFBX_TYPE	The specified class type.
	pCriteria	The given criteria.
	pIndex	The specified index whose default value is 0.

Returns:

The destination object that is the specified class type and that satisfies the given criteria at the specified index, NULL if not found.

Definition at line 870 of file kfbxobject.h.

T* FindDstObject	(	T const *	pFBX_TYPE,
		const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the destination object with the specified name which is of the specified class type, starting at the specified index.

Parameters:

	pFBX_TYPE	The specified class type.
	pName	The object name.
	pStartIndex	The start index.

Returns:

The source object with the name, NULL if not found.

Definition at line 878 of file kfbxobject.h.

T* FindDstObject	(	T const *	pFBX_TYPE,
		KFbxCriteria const &	pCriteria,
		const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches the destination object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index.

Parameters:

	pFBX_TYPE	The specified class type.
	pCriteria	The given criteria.
	pName	The object name.
	pStartIndex	The start index.

Returns:

The source object with the name, NULL if not found.

Definition at line 887 of file kfbxobject.h.

bool ConnectSrcProperty

(

KFbxProperty const &

pProperty

)

[inline]

Connects this object to a source property.

Parameters:

pProperty

The source property with which this object connects.

Returns:

True on success, false otherwise.

Definition at line 899 of file kfbxobject.h.

bool IsConnectedSrcProperty

(

KFbxProperty const &

pProperty

)

[inline]

Judges whether this object connects with the specified source property.

Parameters:

pProperty

The specified source property.

Returns:

True if this object connects with the specified source property, false otherwise.

Definition at line 905 of file kfbxobject.h.

bool DisconnectSrcProperty

(

KFbxProperty const &

pProperty

)

[inline]

Disconnects this object from the specified source property.

Parameters:

pProperty

The specified source property.

Returns:

True on success, false otherwise.

Definition at line 911 of file kfbxobject.h.

int GetSrcPropertyCount

(

)

const [inline]

Returns the number of source properties with which this object connects.

Returns:

The number of source properties with which this object connects.

Definition at line 916 of file kfbxobject.h.

KFbxProperty GetSrcProperty

(

int

pIndex = 0

)

const [inline]

Returns the source property at the specified index with which this object connects.

Parameters:

pIndex

The specified index.

Returns:

The source property at the specified index.

Definition at line 922 of file kfbxobject.h.

KFbxProperty FindSrcProperty	(	const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches a source property with which this object connects that has a specific name, starting at the specified index.

Parameters:

	pName	The specified property name.
	pStartIndex	The start index.

Returns:

The source property with the specified name.

Definition at line 929 of file kfbxobject.h.

bool ConnectDstProperty

(

KFbxProperty const &

pProperty

)

[inline]

Connects this object to a destination property.

Parameters:

pProperty

The destination property with which this object connects.

Returns:

True on success, false otherwise.

Definition at line 935 of file kfbxobject.h.

bool IsConnectedDstProperty

(

KFbxProperty const &

pProperty

)

[inline]

Judges if this object connects with the specified destination property.

Parameters:

pProperty

The specified destination property.

Returns:

True if this object connects with the specified destination property, false otherwise.

Definition at line 941 of file kfbxobject.h.

bool DisconnectDstProperty

(

KFbxProperty const &

pProperty

)

[inline]

Disconnects this object from the specified destination property.

Parameters:

pProperty

The specified destination property.

Returns:

True on success, false otherwise.

Definition at line 947 of file kfbxobject.h.

int GetDstPropertyCount

(

)

const [inline]

Returns the number of destination properties with which this object connects.

Returns:

The number of destination properties with which this object connects.

Definition at line 952 of file kfbxobject.h.

KFbxProperty GetDstProperty

(

int

pIndex = 0

)

const [inline]

Returns the destination property at the specified index with which this object connects.

Parameters:

pIndex

The specified index.

Returns:

The destination property at the specified index.

Definition at line 958 of file kfbxobject.h.

KFbxProperty FindDstProperty	(	const char *	pName,
		int	pStartIndex = 0
	)			const [inline]

Searches a destination property with which this object connects that has a specific name, starting at the specified index.

Parameters:

	pName	The specified property name.
	pStartIndex	The start index.

Returns:

The destination property with the specified name.

Definition at line 965 of file kfbxobject.h.

void SetUserDataPtr	(	KFbxObjectID const &	pUserID,
		void *	pUserData
	)

Sets the data pointer for an user data record whose ID is pUserID.

Parameters:

	pUserID	The ID of the user data record.
	pUserData	The data pointer of the user data record.

Remarks:

An user data record is composed of an ID and a data pointer. If the user data record identified by pUserID does not exist, a new user data record is created and its data pointer is set as pUserData.

void* GetUserDataPtr

(

KFbxObjectID const &

pUserID

)

const

Returns the data pointer of an user data record whose ID is pUserID.

Parameters:

pUserID

The ID of the user data record.

Returns:

The data pointer of the user data record, NULL if the user data record is not found.

void SetUserDataPtr

(

void *

pUserData

)

[inline]

Sets the data pointer for the user data record whose ID is the object ID.

Parameters:

pUserData

The data pointer of the user data record.

Remarks:

An user data record is composed of an ID and a data pointer. If the user data record identified by pUserID does not exist, a new user data record is created and its data pointer is set as pUserData.

Definition at line 992 of file kfbxobject.h.

void* GetUserDataPtr

(

)

const [inline]

Returns the data pointer of the user data record whose ID is the object ID.

Returns:

The data pointer of the user data record, NULL if the user data record is not found.

Definition at line 997 of file kfbxobject.h.

KFbxDocument* GetDocument

(

)

const

Returns a const pointer to the document that contains this object.

Returns:

A const pointer to the document that contains this object or NULL if the object does not belong to any document.

Referenced by KFbxDocument::IsARootDocument().

KFbxDocument* GetRootDocument

(

)

const

Returns a const pointer to the root document that contains this object.

Returns:

A const pointer to the root document that contains this object or NULL if the object does not belong to any document.

Remarks:

It returns this pointer if this object is a document object and does not belong to any document. That means this object is the root document.

KFbxScene* GetScene

(

)

const

Returns a const pointer to the scene that contains this object.

Returns:

A pointer to the scene that contains this object or NULL if the object does not belong to any scene.

Referenced by KFbxCharacterPose::GetGlobalPosition(), and KFbxCharacterPose::GetLocalPosition().

void EmitMessage

(

KFbxMessage *

pMessage

)

const

Emits a message in all available message emitters in the document or SDK manager.

Parameters:

pMessage

The message to emit.

Remarks:

The ownership of the message is transferred, don't delete it.

virtual const char* Localize	(	const char *	pID,
		const char *	pDefault = NULL
	)			const [virtual]

Localization helper function, it calls the implementation of FBX SDK manager.

Sub-classes that manage their own localization could over-ride this function.

Parameters:

	pID	The identifier of the text to be localized.
	pDefault	The default text. Uses pID as the default text if pDefault is NULL.

Returns:

The localized text or the default text if the text can't be localized, .

Reimplemented in KFbxLibrary.

KFbxLibrary* GetParentLibrary

(

void

)

const

Returns a handle on the parent library of this object.

Returns:

The parent library of this object, or NULL if the parent library doesn't exist.

Reimplemented in KFbxLibrary.

bool AddImplementation

(

KFbxImplementation *

pImplementation

)

Adds an implementation.

Parameters:

pImplementation

The implementation to be added.

Returns:

True on success, false otherwise.

Remarks:

To succeed this function must be called with an implementation that has not already been added to this node.

bool RemoveImplementation

(

KFbxImplementation *

pImplementation

)

Removes an implementation.

Parameters:

pImplementation

The implementation to be removed.

Returns:

True on success, false otherwise.

Remarks:

To succeed this function must be called with an implementation that has already been added to this node.

bool HasDefaultImplementation

(

void

)

const

Judges if this shading node has a default implementation.

Returns:

True if this shading node has a default implementation, false otherwise.

KFbxImplementation* GetDefaultImplementation

(

void

)

const

Returns the default implementation of this shading node.

Returns:

The default implementation of this shading node.

bool SetDefaultImplementation

(

KFbxImplementation *

pImplementation

)

Sets the default implementation of this shading node.

Parameters:

pImplementation

The implementation to be set.

Returns:

True on success, false otherwise.

Remarks:

To succeed this function must be called with an implementation that has already been added to this node. Only the implementation which has already been added can be set as the default implementation.

int GetImplementationCount

(

const KFbxImplementationFilter *

pCriteria = NULL

)

const

Returns the number of implementations that satisfy a given criteria.

Parameters:

pCriteria

The given criteria.

Returns:

The number of implementations.

KFbxImplementation* GetImplementation	(	int	pIndex,
		const KFbxImplementationFilter *	pCriteria = NULL
	)			const

Returns the implementation at the specified index that satisfies the given criteria.

Parameters:

	pIndex	The specified index.
	pCriteria	The given criteria.

Returns:

The implementation at the specified index, NULL if not found.

virtual KString GetUrl

(

)

const [virtual]

Returns the URL of this object.

Returns:

The URL of this object.

Remarks:

The URL indicates where the object is stored.

virtual bool SetUrl

(

char *

pUrl

)

[virtual]

Sets the URL of this object.

Parameters:

pUrl

The URL to be set.

Returns:

True on success, false otherwise.

Remarks:

The URL indicates where the object is stored.

virtual KFbxObject& Copy

(

const KFbxObject &

pObject

)

[virtual]

Copy an object content into this object.

Parameters:

pObject

The source object to copy data from.

Returns:

Returns the destination object being modified by the source.

Remarks:

This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.

---

Member Data Documentation

KFbxProperty RootProperty

Definition at line 498 of file kfbxobject.h.